/*
 * The contents of this web application are subject to the Mozilla Public License Version 
 * 1.1 (the "License"); you may not use this web application except in compliance with 
 * the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, 
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
 * for the specific language governing rights and limitations under the License.
 * 
 * The Original Code is owned by and the Initial Developer of the Original Code is 
 * Composite A/S (Danish business reg.no. 21744409). All Rights Reserved
 * 
 * Section 11 of the License is EXPRESSLY amended to include a provision stating 
 * that any dispute, including but not limited to disputes related to the enforcement 
 * of the License, to which Composite A/S as owner of the Original Code, as Initial 
 * Developer or in any other role, becomes a part to shall be governed by Danish law 
 * and be initiated before the Copenhagen City Court ("K�benhavns Byret")            
 */

using System.Collections.Generic;
using Composite.Data;

namespace Composite.Core.Routing
{
    /// <summary>
    /// An interface for internal url transformation.
    /// </summary>
    public interface IInternalUrlConverter
    {
        /// <summary>
        /// Contains an enumeration of url prefixes for urls current convert is handling
        /// </summary>
        IEnumerable<string> AcceptedUrlPrefixes { get; }

        /// <summary>
        /// Converts a url in an internal format (f.e. "~/page(guid)" or "~/media(guid)") to a public serveable url (f.e. "/page/subpage").
        /// </summary>
        /// <param name="internalUrl">An internal url.</param>
        /// <param name="urlSpace">The target url space.</param>
        /// <returns></returns>
        string ToPublicUrl(string internalUrl, UrlSpace urlSpace);

        /// <summary>
        /// Converts an internal url in an internal format (f.e. "~/page(guid)" or "~/media(guid)") to a data reference.
        /// </summary>
        /// <param name="internalUrl">An internal url.</param>
        /// <returns></returns>
        IDataReference ToDataReference(string internalUrl);
    }
}